home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3n / t_connect.z / t_connect
Encoding:
Text File  |  1998-10-20  |  13.5 KB  |  199 lines

  1.  
  2.  
  3.  
  4. tttt____ccccoooonnnnnnnneeeecccctttt((((3333NNNN))))                                                    tttt____ccccoooonnnnnnnneeeecccctttt((((3333NNNN))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _tttt______cccc_oooo_nnnn_nnnn_eeee_cccc_tttt - establish a connection with another transport user
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_ffff_dddd_eeee_ffff ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_xxxx_tttt_iiii_...._hhhh_>>>>
  14.      _####_eeee_llll_ssss_eeee
  15.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_tttt_iiii_uuuu_ssss_eeee_rrrr_...._hhhh_>>>>
  16.      _####_eeee_nnnn_dddd_iiii_ffff
  17.  
  18.      _iiii_nnnn_tttt _tttt______cccc_oooo_nnnn_nnnn_eeee_cccc_tttt_((((_ffff_dddd_,,,, _ssss_nnnn_dddd_cccc_aaaa_llll_llll_,,,, _rrrr_cccc_vvvv_cccc_aaaa_llll_llll_))))
  19.      _iiii_nnnn_tttt _ffff_dddd_;;;;
  20.      _ssss_tttt_rrrr_uuuu_cccc_tttt _tttt______cccc_aaaa_llll_llll _****_ssss_nnnn_dddd_cccc_aaaa_llll_llll_;;;;
  21.      _ssss_tttt_rrrr_uuuu_cccc_tttt _tttt______cccc_aaaa_llll_llll _****_rrrr_cccc_vvvv_cccc_aaaa_llll_llll_;;;;
  22.  
  23. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.      This function enables a transport user to request a connection to the
  25.      specified destination transport user.  _ffff_dddd identifies the local transport
  26.      endpoint where communication will be established, while _ssss_nnnn_dddd_cccc_aaaa_llll_llll and
  27.      _rrrr_cccc_vvvv_cccc_aaaa_llll_llll point to a _tttt______cccc_aaaa_llll_llll structure that contains the following members:
  28.  
  29.           _ssss_tttt_rrrr_uuuu_cccc_tttt _nnnn_eeee_tttt_bbbb_uuuu_ffff _aaaa_dddd_dddd_rrrr_;;;;
  30.           _ssss_tttt_rrrr_uuuu_cccc_tttt _nnnn_eeee_tttt_bbbb_uuuu_ffff _oooo_pppp_tttt_;;;;
  31.           _ssss_tttt_rrrr_uuuu_cccc_tttt _nnnn_eeee_tttt_bbbb_uuuu_ffff _uuuu_dddd_aaaa_tttt_aaaa_;;;;
  32.           _iiii_nnnn_tttt _ssss_eeee_qqqq_uuuu_eeee_nnnn_cccc_eeee_;;;;
  33.  
  34.      _ssss_nnnn_dddd_cccc_aaaa_llll_llll specifies information needed by the transport provider to
  35.      establish a connection and _rrrr_cccc_vvvv_cccc_aaaa_llll_llll specifies information that is
  36.      associated with the newly established connection.
  37.  
  38.      _nnnn_eeee_tttt_bbbb_uuuu_ffff is described in _iiii_nnnn_tttt_rrrr_oooo(3N).  In _ssss_nnnn_dddd_cccc_aaaa_llll_llll, _aaaa_dddd_dddd_rrrr specifies the
  39.      protocol address of the destination transport user, _oooo_pppp_tttt presents any
  40.      protocol-specific information that might be needed by the transport
  41.      provider, _uuuu_dddd_aaaa_tttt_aaaa points to optional user data that may be passed to the
  42.      destination transport user during connection establishment, and _ssss_eeee_qqqq_uuuu_eeee_nnnn_cccc_eeee
  43.      has no meaning for this function.
  44.  
  45.      On return in _rrrr_cccc_vvvv_cccc_aaaa_llll_llll, _aaaa_dddd_dddd_rrrr returns the protocol address associated with
  46.      the responding transport endpoint, _oooo_pppp_tttt presents any protocol-specific
  47.      information associated with the connection, _uuuu_dddd_aaaa_tttt_aaaa points to optional user
  48.      data that may be returned by the destination transport user during
  49.      connection establishment, and _ssss_eeee_qqqq_uuuu_eeee_nnnn_cccc_eeee has no meaning for this function.
  50.  
  51.      The _oooo_pppp_tttt argument implies no structure on the options that may be passed
  52.      to the transport provider.  The transport provider is free to specify the
  53.      structure of any options passed to it.  These options are specific to the
  54.      underlying protocol of the transport provider.  The user may choose not
  55.      to negotiate protocol options by setting the _llll_eeee_nnnn field of _oooo_pppp_tttt to zero.
  56.      In this case, the provider may use default options.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. tttt____ccccoooonnnnnnnneeeecccctttt((((3333NNNN))))                                                    tttt____ccccoooonnnnnnnneeeecccctttt((((3333NNNN))))
  71.  
  72.  
  73.  
  74.      The _uuuu_dddd_aaaa_tttt_aaaa argument enables the caller to pass user data to the
  75.      destination transport user and receive user data from the destination
  76.      user during connection establishment.  However, the amount of user data
  77.      must not exceed the limits supported by the transport provider as
  78.      returned in the _cccc_oooo_nnnn_nnnn_eeee_cccc_tttt field of the _iiii_nnnn_ffff_oooo argument of _tttt______oooo_pppp_eeee_nnnn or
  79.      _tttt______gggg_eeee_tttt_iiii_nnnn_ffff_oooo.  If the _llll_eeee_nnnn [see _nnnn_eeee_tttt_bbbb_uuuu_ffff in _iiii_nnnn_tttt_rrrr_oooo(3N)] field of _uuuu_dddd_aaaa_tttt_aaaa is zero
  80.      in _ssss_nnnn_dddd_cccc_aaaa_llll_llll, no data will be sent to the destination transport user.
  81.  
  82.      On return, the _aaaa_dddd_dddd_rrrr, _oooo_pppp_tttt, and _uuuu_dddd_aaaa_tttt_aaaa fields of _rrrr_cccc_vvvv_cccc_aaaa_llll_llll will be updated to
  83.      reflect values associated with the connection.  Thus, the _mmmm_aaaa_xxxx_llll_eeee_nnnn [see
  84.      _nnnn_eeee_tttt_bbbb_uuuu_ffff in _iiii_nnnn_tttt_rrrr_oooo(3N)] field of each argument must be set before issuing
  85.      this function to indicate the maximum size of the buffer for each.
  86.      However, _rrrr_cccc_vvvv_cccc_aaaa_llll_llll may be NULL, in which case no information is given to
  87.      the user on return from _tttt______cccc_oooo_nnnn_nnnn_eeee_cccc_tttt.
  88.  
  89.      By default, _tttt______cccc_oooo_nnnn_nnnn_eeee_cccc_tttt executes in synchronous mode, and will wait for the
  90.      destination user's response before returning control to the local user.
  91.      A successful return (that is, return value of zero) indicates that the
  92.      requested connection has been established.  However, if _OOOO______NNNN_DDDD_EEEE_LLLL_AAAA_YYYY or
  93.      _OOOO______NNNN_OOOO_NNNN_BBBB_LLLL_OOOO_CCCC_KKKK is set (via _tttt______oooo_pppp_eeee_nnnn or _ffff_cccc_nnnn_tttt_llll), _tttt______cccc_oooo_nnnn_nnnn_eeee_cccc_tttt executes in
  94.      asynchronous mode.  In this case, the call will not wait for the remote
  95.      user's response, but will return control immediately to the local user
  96.      and return -1 with _tttt______eeee_rrrr_rrrr_nnnn_oooo set to _TTTT_NNNN_OOOO_DDDD_AAAA_TTTT_AAAA to indicate that the connection
  97.      has not yet been established.  In this way, the function simply initiates
  98.      the connection establishment procedure by sending a connect request to
  99.      the destination transport user.
  100.  
  101.      This function resides within both the X/Open compliant _llll_iiii_bbbb_xxxx_nnnn_eeee_tttt and the
  102.      SVR4 compliant _llll_iiii_bbbb_nnnn_ssss_llll Network Services libraries.  Network Services
  103.      applications which require X/Open compliance must link-load with _----_llll_xxxx_nnnn_eeee_tttt.
  104.      Network Services applications which require SVR4 compliance must link-
  105.      load with _----_llll_nnnn_ssss_llll.
  106.  
  107.      On failure, _tttt______eeee_rrrr_rrrr_nnnn_oooo may be set to one of the following:
  108.  
  109.      _TTTT_BBBB_AAAA_DDDD_FFFF              The specified file descriptor does not refer to a
  110.                         transport endpoint.
  111.  
  112.      _TTTT_OOOO_UUUU_TTTT_SSSS_TTTT_AAAA_TTTT_EEEE          The function was issued in the wrong sequence.
  113.  
  114.      _TTTT_NNNN_OOOO_DDDD_AAAA_TTTT_AAAA            _OOOO______NNNN_DDDD_EEEE_LLLL_AAAA_YYYY or _OOOO______NNNN_OOOO_NNNN_BBBB_LLLL_OOOO_CCCC_KKKK was set, so the function
  115.                         successfully initiated the connection establishment
  116.                         procedure, but did not wait for a response from the
  117.                         remote user.
  118.  
  119.      _TTTT_BBBB_AAAA_DDDD_AAAA_DDDD_DDDD_RRRR           The specified protocol address was in an incorrect
  120.                         format or contained invalid information.
  121.  
  122.      _TTTT_BBBB_AAAA_DDDD_OOOO_PPPP_TTTT            The specified protocol options were in an incorrect
  123.                         format or contained invalid information.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. tttt____ccccoooonnnnnnnneeeecccctttt((((3333NNNN))))                                                    tttt____ccccoooonnnnnnnneeeecccctttt((((3333NNNN))))
  137.  
  138.  
  139.  
  140.      _TTTT_BBBB_AAAA_DDDD_DDDD_AAAA_TTTT_AAAA           The amount of user data specified was not within the
  141.                         bounds supported by the transport provider as returned
  142.                         in the _cccc_oooo_nnnn_nnnn_eeee_cccc_tttt field of the _iiii_nnnn_ffff_oooo argument of _tttt______oooo_pppp_eeee_nnnn or
  143.                         _tttt______gggg_eeee_tttt_iiii_nnnn_ffff_oooo.
  144.  
  145.      _TTTT_AAAA_CCCC_CCCC_EEEE_SSSS             The user does not have permission to use the specified
  146.                         address or options.
  147.  
  148.      _TTTT_BBBB_UUUU_FFFF_OOOO_VVVV_FFFF_LLLL_WWWW          The number of bytes allocated for an incoming argument
  149.                         is not sufficient to store the value of that argument.
  150.                         If executed in synchronous mode, the provider's state,
  151.                         as seen by the user, changes to _TTTT______DDDD_AAAA_TTTT_AAAA_XXXX_FFFF_EEEE_RRRR, and the
  152.                         connect indication information to be returned in
  153.                         _rrrr_cccc_vvvv_cccc_aaaa_llll_llll is discarded.
  154.  
  155.      _TTTT_LLLL_OOOO_OOOO_KKKK              An asynchronous event has occurred on this transport
  156.                         endpoint and requires immediate attention.
  157.  
  158.      _TTTT_NNNN_OOOO_TTTT_SSSS_UUUU_PPPP_PPPP_OOOO_RRRR_TTTT        This function is not supported by the underlying
  159.                         transport provider.
  160.  
  161.      _TTTT_SSSS_YYYY_SSSS_EEEE_RRRR_RRRR            A system error has occurred during execution of this
  162.                         function.
  163.  
  164. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  165.      _iiii_nnnn_tttt_rrrr_oooo(3N), _tttt______aaaa_cccc_cccc_eeee_pppp_tttt(3N), _tttt______aaaa_llll_llll_oooo_cccc(3N), _tttt______gggg_eeee_tttt_iiii_nnnn_ffff_oooo(3N), _tttt______llll_iiii_ssss_tttt_eeee_nnnn(3N),
  166.      _tttt______oooo_pppp_eeee_nnnn(3N), _tttt______oooo_pppp_tttt_mmmm_gggg_mmmm_tttt(3N), _tttt______rrrr_cccc_vvvv_cccc_oooo_nnnn_nnnn_eeee_cccc_tttt(3N)
  167.  
  168. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  169.      _tttt______cccc_oooo_nnnn_nnnn_eeee_cccc_tttt returns 0 on success and -1 on failure and _tttt______eeee_rrrr_rrrr_nnnn_oooo is set to
  170.      indicate the error.
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.